<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />

		<title>CKEDITOR.tools - CKEditor 3.0 JavaScript API Documentation</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px;
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}

		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->
		<!-- begin static/header.html -->
		<div id="header">
	<h1>CKEditor 3.0 JavaScript API Documentation</h1>
	<hr />
</div>

		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center">
	<a href="../index.html">Code Index</a>
	| <a href="../files.html">File Index</a>
</div>
<hr />
<h2>Namespaces</h2>
<ul class="classList">




			<li>
				<a href="../symbols/CKEDITOR.html">CKEDITOR</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.ajax.html">CKEDITOR.ajax</a>
			</li>





			<li>
				<a href="../symbols/CKEDITOR.config.html">CKEDITOR.config</a>
			</li>



















			<li>
				<a href="../symbols/CKEDITOR.dom.html">CKEDITOR.dom</a>
			</li>



















			<li>
				<a href="../symbols/CKEDITOR.dtd.html">CKEDITOR.dtd</a>
			</li>





			<li>
				<a href="../symbols/CKEDITOR.env.html">CKEDITOR.env</a>
			</li>





















			<li>
				<a href="../symbols/CKEDITOR.imageCacher.html">CKEDITOR.imageCacher</a>
			</li>





			<li>
				<a href="../symbols/CKEDITOR.loader.html">CKEDITOR.loader</a>
			</li>





			<li>
				<a href="../symbols/CKEDITOR.plugins.html">CKEDITOR.plugins</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.resourceManager.html">CKEDITOR.resourceManager</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.scriptLoader.html">CKEDITOR.scriptLoader</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.skins.html">CKEDITOR.skins</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.test.html">CKEDITOR.test</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.themes.html">CKEDITOR.themes</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.tools.html">CKEDITOR.tools</a>
			</li>




































</ul>
<h2>Classes</h2>
<ul class="classList">








			<li>
				<a href="../symbols/CKEDITOR.commandDefinition.html">CKEDITOR.commandDefinition</a>
			</li>





			<li>
				<a href="../symbols/CKEDITOR.dialog.html">CKEDITOR.dialog</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.dialog.buttonDefinition.html">CKEDITOR.dialog.buttonDefinition</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.dialog.contentDefinition.html">CKEDITOR.dialog.contentDefinition</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.dialog.contentDefinitionObject.html">CKEDITOR.dialog.contentDefinitionObject</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.dialog.dialogDefinition.html">CKEDITOR.dialog.dialogDefinition</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.dialog.dialogDefinitionObject.html">CKEDITOR.dialog.dialogDefinitionObject</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.dialog.uiElementDefinition.html">CKEDITOR.dialog.uiElementDefinition</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.dialogCommand.html">CKEDITOR.dialogCommand</a>
			</li>





			<li>
				<a href="../symbols/CKEDITOR.dom.document.html">CKEDITOR.dom.document</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.dom.domObject.html">CKEDITOR.dom.domObject</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.dom.element.html">CKEDITOR.dom.element</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.dom.event.html">CKEDITOR.dom.event</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.dom.node.html">CKEDITOR.dom.node</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.dom.selection.html">CKEDITOR.dom.selection</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.dom.text.html">CKEDITOR.dom.text</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.dom.window.html">CKEDITOR.dom.window</a>
			</li>





			<li>
				<a href="../symbols/CKEDITOR.editor.html">CKEDITOR.editor</a>
			</li>





			<li>
				<a href="../symbols/CKEDITOR.event.html">CKEDITOR.event</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.eventInfo.html">CKEDITOR.eventInfo</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.focusManager.html">CKEDITOR.focusManager</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.htmlParser.html">CKEDITOR.htmlParser</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.htmlParser.comment.html">CKEDITOR.htmlParser.comment</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.htmlParser.element.html">CKEDITOR.htmlParser.element</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.htmlParser.fragment.html">CKEDITOR.htmlParser.fragment</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.htmlParser.text.html">CKEDITOR.htmlParser.text</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.htmlWriter.html">CKEDITOR.htmlWriter</a>
			</li>





			<li>
				<a href="../symbols/CKEDITOR.keystrokeHandler.html">CKEDITOR.keystrokeHandler</a>
			</li>





			<li>
				<a href="../symbols/CKEDITOR.pluginDefinition.html">CKEDITOR.pluginDefinition</a>
			</li>

















			<li>
				<a href="../symbols/CKEDITOR.ui.html">CKEDITOR.ui</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.ui.button.html">CKEDITOR.ui.button</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.ui.dialog.button.html">CKEDITOR.ui.dialog.button</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.ui.dialog.checkbox.html">CKEDITOR.ui.dialog.checkbox</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.ui.dialog.file.html">CKEDITOR.ui.dialog.file</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.ui.dialog.fileButton.html">CKEDITOR.ui.dialog.fileButton</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.ui.dialog.hbox.html">CKEDITOR.ui.dialog.hbox</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.ui.dialog.html.html">CKEDITOR.ui.dialog.html</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.ui.dialog.labeledElement.html">CKEDITOR.ui.dialog.labeledElement</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.ui.dialog.radio.html">CKEDITOR.ui.dialog.radio</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.ui.dialog.select.html">CKEDITOR.ui.dialog.select</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.ui.dialog.textarea.html">CKEDITOR.ui.dialog.textarea</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.ui.dialog.textInput.html">CKEDITOR.ui.dialog.textInput</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.ui.dialog.uiElement.html">CKEDITOR.ui.dialog.uiElement</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.ui.dialog.vbox.html">CKEDITOR.ui.dialog.vbox</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.ui.handlerDefinition.html">CKEDITOR.ui.handlerDefinition</a>
			</li>



			<li>
				<a href="../symbols/CKEDITOR.xml.html">CKEDITOR.xml</a>
			</li>


</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>

		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">

				Namespace CKEDITOR.tools
			</h1>

<!-- ============================== class summary ========================== -->
			<p class="description">



Utility functions.


					<br /><i>Defined in: </i> <a href="../symbols/src/core_tools.js.html">core/tools.js</a>.

			</p>

<!-- ============================== constructor summary ==================== -->

			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class CKEDITOR.tools.">
				<caption>Namespace Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/CKEDITOR.tools.html#constructor">CKEDITOR.tools</a></b>
							</div>
							<div class="description">Utility functions.</div>
						</td>
					</tr>
				</tbody>
			</table>


<!-- ============================== properties summary ===================== -->


<!-- ============================== methods summary ======================== -->



				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class CKEDITOR.tools.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>

						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">CKEDITOR.tools.<b><a href="../symbols/CKEDITOR.tools.html#.cssStyleToDomStyle">cssStyleToDomStyle</a></b>(cssName)
								</div>
								<div class="description">Transforms a CSS property name to its relative DOM style name.</div>
							</td>
						</tr>

						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">CKEDITOR.tools.<b><a href="../symbols/CKEDITOR.tools.html#.extend">extend</a></b>(target, source[,souce(n)], overwrite)
								</div>
								<div class="description">Copy the properties from one object to another.</div>
							</td>
						</tr>

						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">CKEDITOR.tools.<b><a href="../symbols/CKEDITOR.tools.html#.getNextNumber">getNextNumber</a></b>()
								</div>
								<div class="description">Gets a unique number for this CKEDITOR execution session.</div>
							</td>
						</tr>

						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">CKEDITOR.tools.<b><a href="../symbols/CKEDITOR.tools.html#.htmlEncode">htmlEncode</a></b>(text)
								</div>
								<div class="description">Replace special HTML characters in a string with their relative HTML
entity values.</div>
							</td>
						</tr>

						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">CKEDITOR.tools.<b><a href="../symbols/CKEDITOR.tools.html#.indexOf">indexOf</a></b>(array, entry)
								</div>
								<div class="description">Returns the index of an element in an array.</div>
							</td>
						</tr>

						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">CKEDITOR.tools.<b><a href="../symbols/CKEDITOR.tools.html#.isArray">isArray</a></b>(object)
								</div>
								<div class="description">Checks if an object is an Array.</div>
							</td>
						</tr>

						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">CKEDITOR.tools.<b><a href="../symbols/CKEDITOR.tools.html#.ltrim">ltrim</a></b>(str)
								</div>
								<div class="description">Remove spaces from the start (left) of a string.</div>
							</td>
						</tr>

						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">CKEDITOR.tools.<b><a href="../symbols/CKEDITOR.tools.html#.override">override</a></b>(originalFunction, functionBuilder)
								</div>
								<div class="description">Creates a function override.</div>
							</td>
						</tr>

						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">CKEDITOR.tools.<b><a href="../symbols/CKEDITOR.tools.html#.rtrim">rtrim</a></b>(str)
								</div>
								<div class="description">Remove spaces from the end (right) of a string.</div>
							</td>
						</tr>

						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">CKEDITOR.tools.<b><a href="../symbols/CKEDITOR.tools.html#.setTimeout">setTimeout</a></b>(func, milliseconds, scope, args, ownerWindow)
								</div>
								<div class="description">Executes a function after specified delay.</div>
							</td>
						</tr>

						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">CKEDITOR.tools.<b><a href="../symbols/CKEDITOR.tools.html#.trim">trim</a></b>(str)
								</div>
								<div class="description">Remove spaces from the start and the end of a string.</div>
							</td>
						</tr>

						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/CKEDITOR.tools.html#dCopy">dCopy</a></b>(source)
								</div>
								<div class="description">Creates an object which is an instance of a class which prototype is a
predefined object.</div>
							</td>
						</tr>

					</tbody>
				</table>





<!-- ============================== constructor details ==================== -->

			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Namespace Detail
				</div>

				<div class="fixedFont" style="float:left">
						<b>CKEDITOR.tools</b>
				</div>

				<div style="float:right">
					<span class="heading">Since:</span>

							3.0

				</div>
				<div style="clear:both"></div>

				<div class="description">
					Utility functions.

				</div>















			</div>


<!-- ============================== field details ========================== -->


<!-- ============================== method details ========================= -->

				<div class="sectionTitle">
					Method Detail
				</div>

					<a name=".cssStyleToDomStyle"> </a>
					<div class="fixedFont" style="float:left">&lt;static&gt;

					<span class="light">{String}</span>
					<span class="light">CKEDITOR.tools.</span><b>cssStyleToDomStyle</b>(cssName)

					</div>
					<div style="float:right">
						<span class="heading">Since:</span>

								3.0

					</div>
					<div style="clear:both"></div>
					<div class="description">
						Transforms a CSS property name to its relative DOM style name.


					</div>




							<pre class="code">alert( CKEDITOR.tools.cssStyleToDomStyle( 'background-color' ) );  // "backgroundColor"
alert( CKEDITOR.tools.cssStyleToDomStyle( 'float' ) );             // "cssFloat"</pre>





							<dl class="detailList">
							<dt class="heading">Parameters:</dt>

								<dt>
									<span class="light fixedFont">{String}</span> <b>cssName</b>

								</dt>
								<dd>The CSS property name.</dd>

							</dl>




							<dl class="detailList">
							<dt class="heading">Returns:</dt>

								<dd><span class="light fixedFont">{String}</span> The transformed name.</dd>

							</dl>




					<hr />

					<a name=".extend"> </a>
					<div class="fixedFont" style="float:left">&lt;static&gt;

					<span class="light">{Object}</span>
					<span class="light">CKEDITOR.tools.</span><b>extend</b>(target, source[,souce(n)], overwrite)

					</div>
					<div style="float:right">
						<span class="heading">Since:</span>

								3.0

					</div>
					<div style="clear:both"></div>
					<div class="description">
						Copy the properties from one object to another. By default, properties
already present in the target object <strong>are not</strong> overwritten.


					</div>




							<pre class="code">// Create the sample object.
var myObject =
{
    prop1 : true
};

// Extend the above object with two properties.
CKEDITOR.tools.extend( myObject,
    {
        prop2 : true,
        prop3 : true
    } );

// Alert "prop1", "prop2" and "prop3".
for ( var p in myObject )
    alert( p );</pre>





							<dl class="detailList">
							<dt class="heading">Parameters:</dt>

								<dt>
									<span class="light fixedFont">{Object}</span> <b>target</b>

								</dt>
								<dd>The object to be extended.</dd>

								<dt>
									<span class="light fixedFont">{Object}</span> <b>source[,souce(n)]</b>

								</dt>
								<dd>The objects from which copy
		properties. Any number of objects can be passed to this function.</dd>

								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>overwrite</b>
									<i>Optional</i>
								</dt>
								<dd>Indicates that properties already present
		in the target object must be overwritten. This must be the last
		parameter in the function call.</dd>

							</dl>




							<dl class="detailList">
							<dt class="heading">Returns:</dt>

								<dd><span class="light fixedFont">{Object}</span> the extended object (target).</dd>

							</dl>




					<hr />

					<a name=".getNextNumber"> </a>
					<div class="fixedFont" style="float:left">&lt;static&gt;

					<span class="light">{Number}</span>
					<span class="light">CKEDITOR.tools.</span><b>getNextNumber</b>()

					</div>
					<div style="float:right">
						<span class="heading">Since:</span>

								3.0

					</div>
					<div style="clear:both"></div>
					<div class="description">
						Gets a unique number for this CKEDITOR execution session. It returns
progressive numbers starting at 1.


					</div>




							<pre class="code">alert( CKEDITOR.tools.<b>getNextNumber()</b> );  // "1" (e.g.)
alert( CKEDITOR.tools.<b>getNextNumber()</b> );  // "2"</pre>








							<dl class="detailList">
							<dt class="heading">Returns:</dt>

								<dd><span class="light fixedFont">{Number}</span> A unique number.</dd>

							</dl>




					<hr />

					<a name=".htmlEncode"> </a>
					<div class="fixedFont" style="float:left">&lt;static&gt;

					<span class="light">{String}</span>
					<span class="light">CKEDITOR.tools.</span><b>htmlEncode</b>(text)

					</div>
					<div style="float:right">
						<span class="heading">Since:</span>

								3.0

					</div>
					<div style="clear:both"></div>
					<div class="description">
						Replace special HTML characters in a string with their relative HTML
entity values.


					</div>




							<pre class="code">alert( CKEDITOR.tools.htmlEncode( 'A > B & C < D' ) );  // "A &amp;gt; B &amp;amp; C &amp;lt; D"</pre>





							<dl class="detailList">
							<dt class="heading">Parameters:</dt>

								<dt>
									<span class="light fixedFont">{String}</span> <b>text</b>

								</dt>
								<dd>The string to be encoded.</dd>

							</dl>




							<dl class="detailList">
							<dt class="heading">Returns:</dt>

								<dd><span class="light fixedFont">{String}</span> The encode string.</dd>

							</dl>




					<hr />

					<a name=".indexOf"> </a>
					<div class="fixedFont" style="float:left">&lt;static&gt;

					<span class="light">{Number}</span>
					<span class="light">CKEDITOR.tools.</span><b>indexOf</b>(array, entry)

					</div>
					<div style="float:right">
						<span class="heading">Since:</span>

								3.0

					</div>
					<div style="clear:both"></div>
					<div class="description">
						Returns the index of an element in an array.


					</div>




							<pre class="code">var letters = [ 'a', 'b', 'c' ];
alert( CKEDITOR.tools.indexOf( letters, 'b' ) );  "1"</pre>





							<dl class="detailList">
							<dt class="heading">Parameters:</dt>

								<dt>
									<span class="light fixedFont">{Array}</span> <b>array</b>

								</dt>
								<dd>The array to be searched.</dd>

								<dt>
									<span class="light fixedFont">{Object}</span> <b>entry</b>

								</dt>
								<dd>The element to be found.</dd>

							</dl>




							<dl class="detailList">
							<dt class="heading">Returns:</dt>

								<dd><span class="light fixedFont">{Number}</span> The (zero based) index of the first entry that matches
		the entry, or -1 if not found.</dd>

							</dl>




					<hr />

					<a name=".isArray"> </a>
					<div class="fixedFont" style="float:left">&lt;static&gt;

					<span class="light">{Boolean}</span>
					<span class="light">CKEDITOR.tools.</span><b>isArray</b>(object)

					</div>
					<div style="float:right">
						<span class="heading">Since:</span>

								3.0

					</div>
					<div style="clear:both"></div>
					<div class="description">
						Checks if an object is an Array.


					</div>




							<pre class="code">alert( CKEDITOR.tools.isArray( [] ) );      // "true"
alert( CKEDITOR.tools.isArray( 'Test' ) );  // "false"</pre>





							<dl class="detailList">
							<dt class="heading">Parameters:</dt>

								<dt>
									<span class="light fixedFont">{Object}</span> <b>object</b>

								</dt>
								<dd>The object to be checked.</dd>

							</dl>




							<dl class="detailList">
							<dt class="heading">Returns:</dt>

								<dd><span class="light fixedFont">{Undefined}</span> <i>true</i> if the object is an Array, otherwise <i>false</i>.</dd>

							</dl>




					<hr />

					<a name=".ltrim"> </a>
					<div class="fixedFont" style="float:left">&lt;static&gt;

					<span class="light">{String}</span>
					<span class="light">CKEDITOR.tools.</span><b>ltrim</b>(str)

					</div>
					<div style="float:right">
						<span class="heading">Since:</span>

								3.0

					</div>
					<div style="clear:both"></div>
					<div class="description">
						Remove spaces from the start (left) of a string. The following
characters are removed: space, tab, line break, line feed.


					</div>




							<pre class="code">alert( CKEDITOR.tools.ltrim( '  example ' );  // "example "</pre>





							<dl class="detailList">
							<dt class="heading">Parameters:</dt>

								<dt>
									<span class="light fixedFont">{String}</span> <b>str</b>

								</dt>
								<dd>The text from which remove the spaces.</dd>

							</dl>




							<dl class="detailList">
							<dt class="heading">Returns:</dt>

								<dd><span class="light fixedFont">{String}</span> The modified string excluding the removed spaces.</dd>

							</dl>




					<hr />

					<a name=".override"> </a>
					<div class="fixedFont" style="float:left">&lt;static&gt;

					<span class="light">{Function}</span>
					<span class="light">CKEDITOR.tools.</span><b>override</b>(originalFunction, functionBuilder)

					</div>
					<div style="float:right">
						<span class="heading">Since:</span>

								3.0

					</div>
					<div style="clear:both"></div>
					<div class="description">
						Creates a function override.


					</div>




							<pre class="code">var example =
{
    myFunction : function( name )
    {
        alert( 'Name: ' + name );
    }
};

example.myFunction = CKEDITOR.tools.override( example.myFunction, function( myFunctionOriginal )
    {
        return function( name )
            {
                alert( 'Override Name: ' + name );
                myFunctionOriginal.call( this, name );
            };
    });</pre>





							<dl class="detailList">
							<dt class="heading">Parameters:</dt>

								<dt>
									<span class="light fixedFont">{Function}</span> <b>originalFunction</b>

								</dt>
								<dd>The function to be overridden.</dd>

								<dt>
									<span class="light fixedFont">{Function}</span> <b>functionBuilder</b>

								</dt>
								<dd>A function that returns the new
		function. The original function reference will be passed to this
		function.</dd>

							</dl>




							<dl class="detailList">
							<dt class="heading">Returns:</dt>

								<dd><span class="light fixedFont">{Function}</span> The new function.</dd>

							</dl>




					<hr />

					<a name=".rtrim"> </a>
					<div class="fixedFont" style="float:left">&lt;static&gt;

					<span class="light">{String}</span>
					<span class="light">CKEDITOR.tools.</span><b>rtrim</b>(str)

					</div>
					<div style="float:right">
						<span class="heading">Since:</span>

								3.0

					</div>
					<div style="clear:both"></div>
					<div class="description">
						Remove spaces from the end (right) of a string. The following
characters are removed: space, tab, line break, line feed.


					</div>




							<pre class="code">alert( CKEDITOR.tools.ltrim( '  example ' );  // "  example"</pre>





							<dl class="detailList">
							<dt class="heading">Parameters:</dt>

								<dt>
									<span class="light fixedFont">{String}</span> <b>str</b>

								</dt>
								<dd>The text from which remove the spaces.</dd>

							</dl>




							<dl class="detailList">
							<dt class="heading">Returns:</dt>

								<dd><span class="light fixedFont">{String}</span> The modified string excluding the removed spaces.</dd>

							</dl>




					<hr />

					<a name=".setTimeout"> </a>
					<div class="fixedFont" style="float:left">&lt;static&gt;

					<span class="light">{Object}</span>
					<span class="light">CKEDITOR.tools.</span><b>setTimeout</b>(func, milliseconds, scope, args, ownerWindow)

					</div>
					<div style="float:right">
						<span class="heading">Since:</span>

								3.0

					</div>
					<div style="clear:both"></div>
					<div class="description">
						Executes a function after specified delay.


					</div>




							<pre class="code">CKEDITOR.tools.<b>setTimeout(
    function()
    {
        alert( 'Executed after 2 seconds' );
    },
    2000 )</b>;</pre>





							<dl class="detailList">
							<dt class="heading">Parameters:</dt>

								<dt>
									<span class="light fixedFont">{Function}</span> <b>func</b>

								</dt>
								<dd>The function to be executed.</dd>

								<dt>
									<span class="light fixedFont">{Number}</span> <b>milliseconds</b>
									<i>Optional</i>
								</dt>
								<dd>The amount of time (millisecods) to wait
		to fire the function execution. Defaults to zero.</dd>

								<dt>
									<span class="light fixedFont">{Object}</span> <b>scope</b>
									<i>Optional</i>
								</dt>
								<dd>The object to hold the function execution scope
		(the "this" object). By default the "window" object.</dd>

								<dt>
									<span class="light fixedFont">{Object|Array}</span> <b>args</b>
									<i>Optional</i>
								</dt>
								<dd>A single object, or an array of objects, to
		pass as arguments to the function.</dd>

								<dt>
									<span class="light fixedFont">{Object}</span> <b>ownerWindow</b>
									<i>Optional</i>
								</dt>
								<dd>The window that will be used to set the
		timeout. By default the current "window".</dd>

							</dl>




							<dl class="detailList">
							<dt class="heading">Returns:</dt>

								<dd><span class="light fixedFont">{Object}</span> A value that can be used to cancel the function execution.</dd>

							</dl>




					<hr />

					<a name=".trim"> </a>
					<div class="fixedFont" style="float:left">&lt;static&gt;

					<span class="light">{String}</span>
					<span class="light">CKEDITOR.tools.</span><b>trim</b>(str)

					</div>
					<div style="float:right">
						<span class="heading">Since:</span>

								3.0

					</div>
					<div style="clear:both"></div>
					<div class="description">
						Remove spaces from the start and the end of a string. The following
characters are removed: space, tab, line break, line feed.


					</div>




							<pre class="code">alert( CKEDITOR.tools.trim( '  example ' );  // "example"</pre>





							<dl class="detailList">
							<dt class="heading">Parameters:</dt>

								<dt>
									<span class="light fixedFont">{String}</span> <b>str</b>

								</dt>
								<dd>The text from which remove the spaces.</dd>

							</dl>




							<dl class="detailList">
							<dt class="heading">Returns:</dt>

								<dd><span class="light fixedFont">{String}</span> The modified string without the boundary spaces.</dd>

							</dl>




					<hr />

					<a name="dCopy"> </a>
					<div class="fixedFont" style="float:left">

					<span class="light">{Object}</span>
					<b>dCopy</b>(source)

					</div>
					<div style="float:right">
						<span class="heading">Since:</span>

								3.0

					</div>
					<div style="clear:both"></div>
					<div class="description">
						Creates an object which is an instance of a class which prototype is a
predefined object. All properties defined in the source object are
automatically inherited by the resulting object, including future
changes to it.


					</div>


						<pre class="code"><span style="color:red">NO EXAMPLE AVAILABLE</span></pre>



							<dl class="detailList">
							<dt class="heading">Parameters:</dt>

								<dt>
									<span class="light fixedFont">{Object}</span> <b>source</b>

								</dt>
								<dd>The source object to be used as the prototype for
		the final object.</dd>

							</dl>




							<dl class="detailList">
							<dt class="heading">Returns:</dt>

								<dd><span class="light fixedFont">{Object}</span> The resulting copy.</dd>

							</dl>








			<hr />
		</div>

<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
	Copyright &copy; 2003-2009, <a href="http://cksource.com/">CKSource</a> - Frederico Knabben. All rights reserved.
</div>

	</body>
</html>
